fix: Add backwards compatability with canvas provider#3773
Open
mannycarrera4 wants to merge 19 commits intoWorkday:prerelease/majorfrom
Open
fix: Add backwards compatability with canvas provider#3773mannycarrera4 wants to merge 19 commits intoWorkday:prerelease/majorfrom
mannycarrera4 wants to merge 19 commits intoWorkday:prerelease/majorfrom
Conversation
Workday/canvas-kit
|
||||||||||||||||||||||||||||||||||||||||
| Project |
Workday/canvas-kit
|
| Branch Review |
mc-forward-theming
|
| Run status |
|
| Run duration | 02m 24s |
| Commit |
|
| Committer | Manuel Carrera |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
15
|
Skipped
|
0
|
Passing
|
790
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
19.37%
|
|
|---|---|
|
Untested elements
|
1530
|
|
Tested elements
|
365
|
Accessibility
99.38%
|
|
|---|---|
|
Failed rules
|
5 critical
5 serious
0 moderate
2 minor
|
|
Failed elements
|
67
|
…/canvas-kit into mc-forward-theming
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds backwards compatibility to CanvasProvider for customizing theming via the theme prop. It addresses issue #3747 where the old theme format (e.g., brand.primary.base) doesn't work with the new semantic brand token system (e.g., brand.primary.600 and system.color.brand.*). The implementation creates mappings from deprecated theme palette keys to both legacy brand tokens and new numerical/system brand tokens.
Changes:
- Added comprehensive token mapping logic in
CanvasProviderto forward theme values from old palette format to new brand and system tokens - Updated popup theming to apply CSS variables earlier and remove cleanup to prevent theme flashing
- Updated documentation and examples to demonstrate scoped theming with the new backwards-compatible approach
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/react/common/lib/CanvasProvider.tsx | Core backwards compatibility logic with mappings from deprecated palette keys to numerical brand tokens and system tokens |
| modules/react/popup/lib/hooks/usePopupStack.ts | Refactored theme application timing and removed cleanup to prevent cascade barriers and theme flashing |
| modules/react/popup/stories/visual-testing/Popup.stories.tsx | Updated PopupThemed story to properly test themed popup with trigger button |
| modules/react/common/stories/mdx/examples/Theming.tsx | Updated example to demonstrate scoped theming with CanvasProvider theme prop |
| modules/react/common/stories/mdx/Theming.mdx | Extensive documentation updates explaining v14/v15 theming approach and backwards compatibility |
| modules/docs/mdx/15.0-UPGRADE-GUIDE.mdx | Added section explaining system brand tokens and backwards compatibility |
| modules/docs/llm/upgrade-guides/15.0-UPGRADE-GUIDE.md | Added section explaining system brand tokens and backwards compatibility |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 2, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 2, 2026
josh-bagwell
reviewed
Mar 3, 2026
josh-bagwell
reviewed
Mar 3, 2026
josh-bagwell
reviewed
Mar 4, 2026
josh-bagwell
approved these changes
Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes: #3747
Release Category
Components
Release Note
We've added backwards compatibility to
CanvasProviderto customize theming via thethemeprop even though our components now use semantic brandable tokens. Consumers should only use this approach when creating ascopedtheme intended to break away from global theming.Checklist
ready for reviewhas been added to PRFor the Reviewer
Where Should the Reviewer Start?
Areas for Feedback? (optional)
Testing Manually
Screenshots or GIFs (if applicable)
Thank You Gif (optional)